home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / utmisc1 / chktex.lha / chktex / chktexrc < prev    next >
Text File  |  1996-04-30  |  16KB  |  523 lines
  1. ##
  2. ##  ChkTeX v1.4, example resource file for ChkTeX.
  3. ##  Copyright (C) 1995-96 Jens T. Berger Thielemann
  4. ##
  5. ##  This program is free software; you can redistribute it and/or modify
  6. ##  it under the terms of the GNU General Public License as published by
  7. ##  the Free Software Foundation; either version 2 of the License, or
  8. ##  (at your option) any later version.
  9. ##
  10. ##  This program is distributed in the hope that it will be useful,
  11. ##  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13. ##  GNU General Public License for more details.
  14. ##
  15. ##  You should have received a copy of the GNU General Public License
  16. ##  along with this program; if not, write to the Free Software
  17. ##  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18. ##
  19. ##  Contact the author at:
  20. ##      Jens Berger
  21. ##      Spektrumvn. 4
  22. ##      N-0666 Oslo
  23. ##      Norway
  24. ##      E-mail: <jensthi@ifi.uio.no>
  25. ##
  26.  
  27. #####################################################################
  28. #
  29. # Note:   The  format  has  changed slightly.  `=' is also used after
  30. # keywords now; you may sometimes need to escape this.
  31. #
  32. # Comments  begin  with  '#', and continues for the rest of the line.
  33. # Blank lines plus leading and trailing spaces are of course ignored.
  34. #
  35. # The general format of this file is the following:
  36. #
  37. # KEYWORD
  38. # {
  39. #     item item item  ...
  40. #     item item item  ...
  41. #       :    :    :
  42. #     item item item  ...
  43. # }
  44. #
  45. # KEYWORD = item
  46. #
  47. # This  does  _not_  mean  that  you may alternate the forms; certain
  48. # keywords  demands  a  list, other a single value.  You thus have to
  49. # look at the examples of their use.
  50. #
  51. # A  flowchart  of  the  parser  is  given below; more for the fun of
  52. # creating  it  rather  than  explaining  anything  (this  format  is
  53. # trivial).
  54. #
  55. #                                ,-------<-------.
  56. #                                |               ^
  57. #                        ,---.   v   ,-------.   |   ,---.
  58. #                    ,->-| { |->-+->-| Token |->-+->-| } |->-.
  59. #      ,---------.   |   `---'       `-------'       `---'   |
  60. # -+->-| Keyword |->-+                                       +->-+->-
  61. #  ^   `---------'   v         ,---.       ,-------.         |   |
  62. #  |                 `---->----| = |--->---| Token |---->----'   |
  63. #  |                           `---'       `-------'             |
  64. #  |                                                             v
  65. #  `-----------------------------------<-------------------------'
  66. #
  67. #
  68. # Please  also  note  that if you specify a list-keyword twice, we'll
  69. # concatenate  the  lists.   If you you specify a item-keyword twice,
  70. # we'll kill the previous value.
  71. #
  72. # Items  are separated by spaces.  Newlines are considered as spaces,
  73. # but  can't be escaped.  You may surround items with quotes (`"') to
  74. # easily put spaces into them.
  75. #
  76. # Escape sequences available:
  77. #
  78. #   Sequence        Resulting character
  79. #   !               A space (type `! ', not just a exclamation mark)
  80. #   !"              "
  81. #   !#              #
  82. #   !!              !
  83. #   !{              {
  84. #   !}              }
  85. #   !=              =
  86. #   !b              Backspace
  87. #   !n              New line
  88. #   !r              Carriage return
  89. #   !t              Tab
  90. #   !f              Form feed
  91. #   !xNN            NN must be a hexadecimal number (00 - ff),
  92. #                   _both_ characters must be included.
  93. #   !dNNN           DDD must be a decimal number (000 - 255), all
  94. #                   three characters must be included. Unspecified
  95. #                   results if DDD > 255.
  96. #   !NNN            DDD must be a octal number (000 - 377), all
  97. #                   three characters must be included. Unspecified
  98. #                   results if DDD > 377.
  99. #
  100. # Minor  note:   As  you  can see, most of these escape sequences are
  101. # equal  to  those  in  C  (with  some extensions); however, we use !
  102. # instead of \ as escape character for obvious reasons.
  103. #
  104.  
  105.  
  106. #####################################################################
  107. #
  108. # Here, you can put default commandline options; most users would for
  109. # instance like to put -v2 here.
  110. #
  111.  
  112. CMDLINE
  113. {
  114.  
  115. }
  116.  
  117. #####################################################################
  118. #
  119. # These  patterns  will  be  searched for through the text; no matter
  120. # whether   they   appear  as  normal  text,  commands  or  whatever.
  121. # Currently case-sensitive.
  122. #
  123. # I usually define a special command like this:
  124. #
  125. # \def\unknown{\large\bf??}
  126. #
  127. # which  I use whenever there is some information I don't have at the
  128. # moment of writing.  Thus, it makes sense to search for it.
  129. #
  130. # You should be able to develop your own uses for this.
  131. #
  132.  
  133. USERWARN
  134. {
  135.  
  136.     \unknown
  137. ###
  138. #
  139. # Another example; one should write \chktex or Chk\TeX - never ChkTeX.
  140. #
  141. ###
  142.  
  143.     ChkTeX
  144. }
  145.  
  146. #####################################################################
  147. #
  148. # Here you can list the path of where ChkTeX should look for files it
  149. # \inputs.   The  //  postfix is currently not supported; we will not
  150. # recursively  search  directories.
  151. #
  152. # By default, we'll search the current directory; any paths specified
  153. # below will be searched in addition to this.
  154. #
  155.  
  156. TEXINPUTS
  157. {
  158.  
  159.  
  160. }
  161.  
  162. #####################################################################
  163. #
  164. # Here you may specify more outputformats for use with the -v option,
  165. # it simply indexes  into this list.  Remember to use ! instead of \,
  166. # though.
  167. #
  168. # For explanation of how % fields expand; look at ChkTeX.{dvi,ps}.
  169. #
  170. # We will by default select entry number _two_ in this list (we count
  171. # from 0), and -v without any parameter selects entry number _three_.
  172. #
  173.  
  174. OUTFORMAT
  175. {
  176.  
  177. # -v0; silent mode
  178. %f%b%l%b%c%b%n%b%m!n
  179.  
  180. # -v1; normal mode
  181. "%k %n in %f line %l: %m!n%r%s%t!n%u!n"
  182.  
  183. # -v2; fancy mode
  184. "%k %n in %f line %l: %m!n%r%i%s%I%t!n!n"
  185.  
  186. # -v3; lacheck mode
  187. "!"%f!", line %l: %m!n"
  188.  
  189. # -v4; verbose lacheck mode
  190. "!"%f!", line %l: %m!n%r%s%t!n%u!n"
  191.  
  192. }
  193.  
  194.  
  195.  
  196. #####################################################################
  197. #
  198. # These  commands  should be ignored when detecting whether a command
  199. # is ended by a space.
  200. #
  201.  
  202. SILENT
  203. {
  204.     \rm \em \bf \it \sl \sf \sc \tt \selectfont
  205.  
  206.     \columnsep \space \item \tiny \footnotesize \small \normalsize
  207.     \normal \large \Large \LARGE \huge \Huge \printindex
  208.  
  209.     \newpage \listoffigures \listoftables \tableofcontents
  210.     \maketitle \makeindex
  211.  
  212.     \hline \hrule \vrule
  213.  
  214.     \centering
  215.  
  216.     \bigskip \medskip \smallskip
  217.  
  218.     \noindent \expandafter
  219.  
  220.     \makeatletter \makeatother
  221.  
  222.     \columnseprule
  223.  
  224.     \textwidth \textheight \hsize \vsize
  225.  
  226.     \if \fi
  227.  
  228.     \csname \endcsname
  229.  
  230.     \z@ \p@ \@warning \typeout
  231.  
  232.     \dots \ldots \input \endinput \nextline \leavevmode \cdots
  233.     \appendix \listfiles \and \quad
  234.     \vfill \vfil \hfill \hfil \topmargin \oddsidemargin
  235.     \frenchspacing \nonfrenchspacing
  236.     \begingroup \endgroup \par
  237. }
  238.  
  239. #####################################################################
  240. #
  241. # Here,  you  can  specify the length of various dashes.  We sort the
  242. # dash according to which type of characters that are on the left and
  243. # right of of it.  We are only conclusive if they are the same.
  244. #
  245. # We associate as follows:
  246. #
  247. #     Name        Type of character on each side
  248. #     HyphDash    Alphabetic (foo-bar)
  249. #     NumDash     Numeric (2--3)
  250. #     WordDash    Space (like this --- see?)
  251. #
  252. # Below you specify how many dashes which are legal in each case.  We
  253. # define 0 as an magic constant which always generates an error.  You
  254. # may specify more than one legal dash-length.
  255. #
  256. # Let's look at an example.  You use the following dash-syntax:
  257. #
  258. #     foo-bar
  259. #     2--3
  260. #     like this---see?
  261. #
  262. #
  263. # HYPHDASH { 1 3 }        # Either a hyphen, or inter-word
  264. # NUMDASH { 2 }           # Between words
  265. # WORDDASH { 0 }          # We never use this
  266. #
  267.  
  268. HYPHDASH
  269. {
  270.     1
  271. }
  272.  
  273. NUMDASH
  274. {
  275.     2
  276. }
  277.  
  278. WORDDASH
  279. {
  280.     3
  281. }
  282.  
  283. #####################################################################
  284. #
  285. # This  keyword  indicates commands  which argument isn't LaTeX code,
  286. # and which thus should be ignored.
  287. #
  288. # We  will also  wipe  optional  arguments  in  _front_ of  the  main 
  289. # argument.
  290. #
  291. # These  commands may be "executed" before they're wiped, so you will
  292. # typically also wish to list filehandling commands and similar here.
  293. #
  294.  
  295. WIPEARG
  296. {
  297.     \label \ref \vref \pageref \index \cite \input \verbatiminput
  298.     \listinginput \verbatimtabinput \include \includeonly
  299.     \bibitem
  300. }
  301.  
  302. #####################################################################
  303. #
  304. # These  environments  contains  material  which  will  be typeset as
  305. # mathematics by LaTeX.  This turns on/off some warnings.
  306. #
  307. # We will automagically append a * to each keyword.
  308. #
  309.  
  310. MATHENVIR
  311. {
  312.     displaymath math eqnarray array equation
  313. }
  314.  
  315. #####################################################################
  316. #
  317. # These  environments  contains  material  which  contents  should be
  318. # ignored.
  319. #
  320. # We will automagically append a * to each keyword.
  321. #
  322.  
  323. VERBENVIR
  324. {
  325.     verbatim comment listing verbatimtab
  326. }
  327.  
  328. #####################################################################
  329. #
  330. # Here  you  should  list  all  those abbreviations which needs to be
  331. # followed  by  `\  ',  like  in "The cat is a animal, i.e.\ a living
  332. # creature".  They are (currently) case-insensitive.
  333. #
  334. # From  v1.3  the  routine  for  recognizing  abbreviations have been
  335. # improved significantly.  First, we define an abbreviation character
  336. # as either an alphabetic character or a dot (`.').
  337. #
  338. # We   recognize   abbreviations  as  any  sequence  of  abbreviation
  339. # characters separated by non-abbreviation characters, which contains
  340. # at  least  two  dots.   This  does  in  fact  catch most multi-word
  341. # abbreviations.
  342. #
  343. # We  do  thus  still need a list of single-worded ones.  They should
  344. # only  have  alphabetic characters and a dot in the end.  If they do
  345. # not, we'll have to use a slower search-mode for those (the one used
  346. # in  v1.2  and  before).  This may be slow if you have a lot of such
  347. # abbreviations.
  348. #
  349. # If  the  linelength  is m, and the number of abbrevs is n, the fast
  350. # routine is O(m log n), while the slow runs at O(m * n).
  351. #
  352. # I've included some abbreviations not catched by the general routine
  353. # in  ChkTeX.   These were found in "The Concise Oxford Dictionary of
  354. # Current English", Oxford University Press, 4th edition, 1956.
  355. #
  356. # Many of  these  abbreviations  were also  provided  by Russ Bubley,
  357. # <russ@scs.leeds.ac.uk>,  and as he points out:  This  list could be
  358. # arbitrarily large.
  359. #
  360. # Please note that some of the abbrevs below are in fact Norwegian...
  361. #
  362.  
  363. ABBREV
  364. {
  365.     1ST. 2ND. 3RD. 4TH. ACC. AD. AM. APOCR. APR. ARGYL. ARIZ. ARR.
  366.     ASST. AUG. AWOL. BC. BRIT.  CAPT. CELS.  CF. CG.
  367.     CH.  CHES. CHRON. CICESTR. CIT. CL. CM. CO. COL. COMB. CON. CONN.
  368.     CONS. COR.  CORP. CP. CPL. CRES. CRESC. CRIM. CU. CUM. CUMB.
  369.     DAG. DAL. DAN. DC. DEC. DEG. DEL. DEP. DEPT. DG.  DKG. DKL.
  370.     DKM. DL. DOA. DOL. DOZ. DR. DRAM. DVS. DYN. DYNAM. EBOR. ECCLES.
  371.     ECCLUS. ED. EDIN. EDM. EDW. EKSL. ESTH. "ET AL." ETC. EVT. EXC. EZEK.
  372.     FAHR. FAX. FEB. FEC. FIG. FIN. FINI. FL. FLOR. FOL. FOM. FR. FRI.
  373.     FT. FUR. GA. GAL. GEN. GEO. GER. GIB. GLAM. GLOS. GM. GR. GS.
  374.     HECTOG. HECTOL. HECTOM. HG. HHV. HL. HM. HMS. HO. HON. HR. HRS. 
  375.     HY. IA. IB. IBID. INC. INCOG. INF. INIT. INKL. INST. INT.
  376.     INTERNAT. INV. IOM. IOU. IS. ISA. ITAL.  JAN. JAS. JER. JF.
  377.     JFR. JN. JNO. JON. JOS. JOSH. JP. JR. JUD. JUDG. JUL. JUN. JUNR. KAN.
  378.     KG. KL. KM. KNT. KT. KV. KW. KY. LA. LAB.  LANCS. LAT. LB. LEICS.
  379.     LEV. LIB. LIEUT. LINCS. LINN.  LITT. LIV. LL. LOC.  LONG. LOQ.
  380.     LTD. MAL.  MAR.  MATRIC. MATT. MEM. MEMO. MESSRS.  MF.
  381.     MGR. MHP. MHT. MIC. MICH. MINN. MISC. MISS. MK. ML. MLLE. MM.
  382.     MME. MO. MOD. MON. MP. MR. MRS. MS. MVA. MX. NAH. NAT. NEB. NEH. NEV.
  383.     NOM. NORTHANTS. NORTHUMB. NORVIC. NOTTS. NOV. OBAD. OBDT. OCT. OKLA.
  384.     OL. ONT. OP. OPP. ORD. OSV. OXF. OXON. OZ. PAR. PBAB. PCS. PD. PDR.
  385.     PEN. PENIN. PERS.  PF. PGA. PHOT. PIZZ. PLC. PM. PNIX. PNXT. 
  386.     PREF. PREP. PRES. PROF. PROL. PROP. PROX. PS. PT. PTY. QC. QED. QR. QT.
  387.     QTY. QUE. QUOT. QV. RALL. RD. RECD. REGT. REM. REPR. REV. ROFFEN. ROM.
  388.     RS. RSVP. RX. RY. SALOP. SAM. SARUM. SAT. SCH. SEC. SECT. SEN. SEP.
  389.     SEPT. SF. SGT. SH. SOC. SOM. SOV. SOVS. SQ. SR. ST. STG. STR. STS. 
  390.     SUPPL. SUPT. SURG. TEL. TENN. THESS. THOS. THU. THURS. TIM. TIT.
  391.     TOM. TREAS. TRS. TRURON. TUE. TUES. TX. ULT. UNIV. VEN. VHA. VIZ. VOL.
  392.     VULG. VV. WAR.  WED.  WINTON. WISC. WISD. WKC. WM. WT. WYO.
  393.     YEO. YORKS. YR. YRS. ZECH. ZEPH.
  394. }
  395.  
  396. #####################################################################
  397. #
  398. # Commands which accent characters, meaning that \i or \j (\imath and
  399. # \jmath in mathmode) should be used instead of `i' and `j'
  400. #
  401.  
  402. IJACCENT
  403. {
  404.     \hat \check \breve \acute \grave \tilde \bar \vec \dot \ddot
  405.  
  406.     \' \` \^ \" \~ \= \. \u \v \H \t
  407.  
  408. ###
  409. #
  410. # The  remaining  accent commands (\c,\d,\b) put their accent _under_
  411. # the  character,  not above, and should thus be used with normal i's
  412. # and j's.
  413. #
  414. ###
  415.  
  416. }
  417.  
  418. #####################################################################
  419. #
  420. # Commands   which,  when  the  group  is  terminated,  needs  italic
  421. # correction.
  422. #
  423. # This does in fact work well with the LaTeX2e commands too...this is
  424. # due  to  that  the  detection  is  rather  weak and dumb.  Oh well,
  425. # simplicity sometimes even saves work. :-)
  426. #
  427.  
  428. ITALIC
  429. {
  430.     \it \em \sl
  431.     \textit \textem \textsl
  432. }
  433.  
  434.  
  435. #####################################################################
  436. #
  437. # These  commands  all have in common that a pagebreak right in front
  438. # of  them  is  highly  undesirable; thus there should be no space in
  439. # front of them.
  440. #
  441.  
  442. POSTLINK
  443. {
  444.     \index \label
  445. }
  446.  
  447. #####################################################################
  448. #
  449. # The  commands  listed  here,  should be prepended with a `~', as in
  450. # "look  in  table~\ref{foo}", to avoid the references being splitted
  451. # across lines.
  452. #
  453.  
  454. LINKER
  455. {
  456.     \ref \vref \pageref \cite
  457. }
  458.  
  459. #####################################################################
  460. #
  461. # Commands/characters  which  should  have  \cdots  in  between, e.g.
  462. # $1+2+3+\cdots+n$.
  463. #
  464.  
  465. CENTERDOTS
  466. {
  467.     = + - \cdot \div & \times
  468. }
  469.  
  470. #####################################################################
  471. #
  472. # Commands/characters  which  should  have  \ldots  in  between, e.g.
  473. # $1,2,3,\ldots,n$.
  474. #
  475.  
  476. LOWDOTS
  477. {
  478.     . , ;
  479. }
  480.  
  481. #####################################################################
  482. #
  483. # In maths mode, there are certain aliases for mathematical operators
  484. # like  sin, cos, etc.  Ignore the leading backslash in the commands,
  485. # and so forth.  You should list these below.
  486. #
  487.  
  488. MATHROMAN
  489. {
  490.     log lg ln lim limsup liminf sin arcsin sinh cos arccos cosh tan
  491.     arctan tanh cot coth sec csc max min sup inf arg ker dim hom det
  492.     exp Pr gcd deg bmod pmod mod
  493. }
  494.  
  495.  
  496. #####################################################################
  497. #
  498. # We're killing \verb@...@ commands and the arguments of the commands
  499. # listed above in WIPEARG by overwriting them with a string or a
  500. # single character.
  501. #
  502. # This  should  not contain an alphabetic character (in case the user
  503. # writes (\foo\verb@bar@), neither should it contain be one of LaTeX'
  504. # reserved  characters  (`#$%&~_^\{}'),  or any parenthesis character
  505. # ('()[]{}').   If  possible,  don't  use  a  punctuation  character,
  506. # either, or any spacing character.
  507. #
  508. # The  asterix is also unsuitable, as some commands behave in another
  509. # way  if  they  are  postpended with an asterix.  Which more or less
  510. # leaves  us  with  the  pipe.
  511. #
  512. # Please  note  that  this  may  also  be  a  _string_, which will be
  513. # repeated until the proper length is reached.
  514. #
  515.  
  516. VerbClear = "|"
  517.  
  518. #
  519. # All for now - have fun.
  520. #
  521. #####################################################################
  522.  
  523.